get-caller-file

What is get-caller-file?

The get-caller-file package is designed to help developers retrieve the path of the file that calls a function. This can be particularly useful for debugging, logging, or tracking the flow of execution in complex applications where functions might be called from various locations.

What are get-caller-file's main functionalities?

Getting the path of the caller file

This feature allows developers to easily identify the file path of the code that called a function. By using `getCallerFile` within a function, it logs the path of the file that initiated the call, aiding in debugging and tracking execution flow.

const getCallerFile = require('get-caller-file');
function someFunction() {
  console.log(getCallerFile());
}

Other packages similar to get-caller-file

callsites

The 'callsites' package provides functionality similar to 'get-caller-file' by returning an array of call sites (stack frames), allowing developers to get more detailed information about the call stack. It offers a broader set of features for inspecting the call stack compared to the focused functionality of 'get-caller-file'.

stack-trace

The 'stack-trace' package is another alternative that allows users to capture and inspect stack traces. While 'get-caller-file' focuses on identifying the caller file, 'stack-trace' provides a more comprehensive set of tools for working with stack traces, including parsing, filtering, and formatting stack frames.

README

get-caller-file

This is a utility, which allows a function to figure out from which file it was invoked. It does so by inspecting v8's stack trace at the time it is invoked.

Inspired by http://stackoverflow.com/questions/13227489

note: this relies on Node/V8 specific APIs, as such other runtimes may not work

Installation

yarn add get-caller-file

Usage

Given:

// ./foo.js
const getCallerFile = require('get-caller-file');

module.exports = function() {
  return getCallerFile(); // figures out who called it
};

// index.js
const foo = require('./foo');

foo() // => /full/path/to/this/file/index.js

Options:

• getCallerFile(position = 2): where position is stack frame whos fileName we want.